Skip to content

Add faq (My interval went down (e.g. from 4 to 3 days) after optimizing my FSRS parameters. Why is that?) #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

GithubAnon0000
Copy link
Contributor

Fixes: #363

Changes

  1. FAQ section has been moved up in the menu, because it didn't allow me to create subsection otherwise.
  2. A subsection (FSRS) has been created for the FAQ.
  3. The FAQ front page description has been updated.
  4. An FAQ (My interval went down (e.g. from 4 to 3 days) after optimizing my FSRS parameters. Why is that?) has been added.

Others

Regarding #275: I added it to the manual, but the way it currently is is quite awkward. Ideally, there'd be only one place to look for the FAQs.

I think it's best to move all FAQs from https://faqs.ankiweb.net/ into the FAQ section of the manual, if they haven't been covered already in the main parts of the manual. Afterwards, the link to the faq page should be removed from the faq.md file.

@Expertium
Copy link
Contributor

Maybe remove the part about DSR? I think a lot of users won't realize that it means Difficulty, Stability, Reterievability. Or maybe expand it and add this link: https://github.com/open-spaced-repetition/fsrs4anki/wiki/abc-of-fsrs

@GithubAnon0000
Copy link
Contributor Author

I opted for expanding it with the link you provided. My reasoning is that it's better to know why optimizing can have this effect, then to just claim that it does.

@Expertium
Copy link
Contributor

Oops, typo
Reterievability -> Retrievability

@brishtibheja
Copy link
Contributor

I don't like this extra subsection. Is there a issue with having this in the same page? There can be a horizontal line seperating the FAQ you're trying to add and the link to the soon-to-be-legacy FAQ site.

@GithubAnon0000
Copy link
Contributor Author

If you look at https://faqs.ankiweb.net/ you can see that the questions are devided into subtopics. Since it's very likely that the FAQ section will expand in the future, I created a subsection (for the subtopics) in advance. That's probably much cleaner than having <hr> everywhere.

@brishtibheja
Copy link
Contributor

I have an idea for how a single-page FAQ section would look like and it doesn't have to have a ton of <hr>.

Since it's very likely that the FAQ section will expand in the future

The thing is, if we remove this page later the link would stop working. If, however, we start with the existing page and move towards subsections if/when needed, the current links would still work in the future.

@GithubAnon0000
Copy link
Contributor Author

GithubAnon0000 commented Apr 11, 2025

As long as it's clean and obvious, I'm fine with it. Feel free to change the PR (which hopefully is possible for you).

@dae
Copy link
Member

dae commented Apr 13, 2025

I'm afraid I'm not fond of this:

  • FAQs are not where the manual should start from
  • I think big FAQ lists are a bit of an anti-pattern. The info is best placed in an appropriate section of the manual, with some topic-specific mini-FAQs being placed on the page if they're really so common that it makes sense to call them out specifically.

@GithubAnon0000
Copy link
Contributor Author

FAQs are not where the manual should start from
I'l move it down again (it will break subfolders).

  • The info is best placed in an appropriate section of the manual, with some topic-specific mini-FAQs being placed on the page if they're really so common that it makes sense to call them out specifically.

Does that mean there will be no single FAQ link in the manual? Or should I link the FAQ sections of those topics into the FAQ page?

@GithubAnon0000 GithubAnon0000 marked this pull request as draft April 13, 2025 05:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add to FAQ "My interval went down (e.g. from 4 to 3 days) after optimizing my parameters. Why is that?"
4 participants